<!DOCTYPE html>
<html>
  <head>
  <meta charset='UTF-8'>
  <title>Atom API Documentation</title>
  <link rel='stylesheet' href='../assets/biscotto.css' type='text/css'>
  <script src='../assets/biscotto.js'></script>
  <script src='../assets/search_data.js'></script>
</head>
  <body>
    <div id='base' data-path='..&#47;'></div>
<div id='header'>
  <div id='menu'>
    <a href='../docs/README.md.html' title='Atom'>Atom</a>
    &raquo;
    <a href='../class_index.html' title='Index'>Index</a>
    &raquo;
    <span class='title'>EditorView</span>
    <nav>
      <ul>
        <li class='noframes'>
          (<a class='noframes' href='EditorView.html#'>no frames</a>)
        </li>
      </ul>
    </nav>
    <div id='search'>
      <a id='class_list_link' href='../class_list.html'>Classes</a>
      <a id='file_list_link' href='../file_list.html'>Files</a>
      <a id='method_list_link' href='../method_list.html'>Methods</a>
      <a id='extra_list_link' href='../extra_list.html'>Extras</a>
    </div>
  </div>
  <iframe id='search_frame'></iframe>
  <div id='fuzzySearch'>
    <input type='text'>
    <ol></ol>
  </div>
  <div id='help'>
    <p>
      Quickly fuzzy find classes, mixins, methods, file:
    </p>
    <ul>
      <li>
        <span>Ctrl-T</span>
        Open fuzzy finder dialog
      </li>
    </ul>
    <p>
      In frame mode you can toggle the list naviation frame on the left side:
    </p>
    <ul>
      <li>
        <span>Ctrl-L</span>
        Toggle list view
      </li>
    </ul>
    <p>
      You can focus a list in frame mode or toggle a tab in frameless mode:
    </p>
    <ul>
      <li>
        <span>Ctrl-C</span>
        Class list
      </li>
      <li>
        <span>Ctrl-I</span>
        Mixin list
      </li>
      <li>
        <span>Ctrl-F</span>
        File list
      </li>
      <li>
        <span>Ctrl-M</span>
        Method list
      </li>
      <li>
        <span>Ctrl-E</span>
        Extras list
      </li>
    </ul>
    <p>
      You can focus and blur the search input:
    </p>
    <ul>
      <li>
        <span>Ctrl-S</span>
        Focus search input
      </li>
      <li>
        <span>Esc</span>
        Blur search input
      </li>
    </ul>
    <p>
      In frameless mode you can close the list tab:
    </p>
    <ul>
      <li>
        <span>Esc</span>
        Close list tab
      </li>
    </ul>
  </div>
</div>
    <div id='content'>
      <h1>
        Class
        EditorView
      </h1>
      <div class='stability-1'>
        <span class='heading'></span>
        <div class='message'></div>
      </div>
      <table class='box'>
        <tr>
          <td>Defined in:</td>
          <td>src&#47;editor-view.coffee</td>
        </tr>
        <tr>
          <td>Inherits:</td>
          <td>
            <a href='View.html'>View</a>
          </td>
        </tr>
      </table>
      <h2>Overview</h2>
      <div class='docstring'>
  <p>Represents the entire visual pane in Atom.</p><p>The EditorView manages the <a href='Editor.html'>Editor</a>, which manages the file buffers.</p><h2 id="requiring-in-packages">Requiring in packages</h2>
<pre><code class="lang-coffee">  {EditorView} = require &#39;atom&#39;
</code></pre>

</div>
<div class='tags'>
</div>
      <h2>Instance Method Summary</h2>
      <ul class='summary'>
  <li>
    <span class='signature'>
      <a href='EditorView.html#getEditor-instance'>
        Editor ::<strong>getEditor</strong>()
      </a>
    </span>
    <span class='desc'>
      Get the underlying editor model for this view.
    </span>
  </li>
  <li>
    <span class='signature'>
      <a href='EditorView.html#getFirstVisibleScreenRow-instance'>
        Number ::<strong>getFirstVisibleScreenRow</strong>()
      </a>
    </span>
    <span class='desc'>
      Retrieves the number of the row that is visible and currently at the top of the editor.
    </span>
  </li>
  <li>
    <span class='signature'>
      <a href='EditorView.html#getFontFamily-instance'>
        String ::<strong>getFontFamily</strong>()
      </a>
    </span>
    <span class='desc'>
      Gets the font family for the editor.
    </span>
  </li>
  <li>
    <span class='signature'>
      <a href='EditorView.html#getFontSize-instance'>
        Number ::<strong>getFontSize</strong>()
      </a>
    </span>
    <span class='desc'>
      Retrieves the font size for the editor.
    </span>
  </li>
  <li>
    <span class='signature'>
      <a href='EditorView.html#getLastVisibleScreenRow-instance'>
        Number ::<strong>getLastVisibleScreenRow</strong>()
      </a>
    </span>
    <span class='desc'>
      Retrieves the number of the row that is visible and currently at the bottom of the editor.
    </span>
  </li>
  <li>
    <span class='signature'>
      <a href='EditorView.html#getPageRows-instance'>
        Number ::<strong>getPageRows</strong>()
      </a>
    </span>
    <span class='desc'>
      Gets the number of actual page rows existing in an editor.
    </span>
  </li>
  <li>
    <span class='signature'>
      <a href='EditorView.html#getPane-instance'>
        Pane ::<strong>getPane</strong>()
      </a>
    </span>
    <span class='desc'>
      Get this view&#39;s pane.
    </span>
  </li>
  <li>
    <span class='signature'>
      <a href='EditorView.html#highlightFoldsContainingBufferRange-instance'>
        ::<strong>highlightFoldsContainingBufferRange</strong>(bufferRange)
      </a>
    </span>
    <span class='desc'>
      Highlight all the folds within the given buffer range.
    </span>
  </li>
  <li>
    <span class='signature'>
      <a href='EditorView.html#isScreenRowVisible-instance'>
        Boolean ::<strong>isScreenRowVisible</strong>(row)
      </a>
    </span>
    <span class='desc'>
      Given a row number, identifies if it is currently visible.
    </span>
  </li>
  <li>
    <span class='signature'>
      <a href='EditorView.html#pageDown-instance'>
        ::<strong>pageDown</strong>()
      </a>
    </span>
    <span class='desc'>
      Emulates the &quot;page down&quot; key, where the last row of a buffer scrolls to become the first.
    </span>
  </li>
  <li>
    <span class='signature'>
      <a href='EditorView.html#pageUp-instance'>
        ::<strong>pageUp</strong>()
      </a>
    </span>
    <span class='desc'>
      Emulates the &quot;page up&quot; key, where the frst row of a buffer scrolls to become the last.
    </span>
  </li>
  <li>
    <span class='signature'>
      <a href='EditorView.html#pixelPositionForBufferPosition-instance'>
        ::<strong>pixelPositionForBufferPosition</strong>(position)
      </a>
    </span>
    <span class='desc'>
      Converts a buffer position to a pixel position.
    </span>
  </li>
  <li>
    <span class='signature'>
      <a href='EditorView.html#pixelPositionForScreenPosition-instance'>
        ::<strong>pixelPositionForScreenPosition</strong>(position)
      </a>
    </span>
    <span class='desc'>
      Converts a screen position to a pixel position.
    </span>
  </li>
  <li>
    <span class='signature'>
      <a href='EditorView.html#redraw-instance'>
        ::<strong>redraw</strong>()
      </a>
    </span>
    <span class='desc'>
      Redraw the editor
    </span>
  </li>
  <li>
    <span class='signature'>
      <a href='EditorView.html#scrollToBottom-instance'>
        ::<strong>scrollToBottom</strong>()
      </a>
    </span>
    <span class='desc'>
      Scrolls the editor to the bottom.
    </span>
  </li>
  <li>
    <span class='signature'>
      <a href='EditorView.html#scrollToBufferPosition-instance'>
        ::<strong>scrollToBufferPosition</strong>(bufferPosition, options)
      </a>
    </span>
    <span class='desc'>
      Scrolls the editor to the given buffer position.
    </span>
  </li>
  <li>
    <span class='signature'>
      <a href='EditorView.html#scrollToCursorPosition-instance'>
        ::<strong>scrollToCursorPosition</strong>()
      </a>
    </span>
    <span class='desc'>
      Scrolls the editor to the position of the most recently added cursor.
    </span>
  </li>
  <li>
    <span class='signature'>
      <a href='EditorView.html#scrollToPixelPosition-instance'>
        ::<strong>scrollToPixelPosition</strong>(pixelPosition, options)
      </a>
    </span>
    <span class='desc'>
      Scrolls the editor to the given pixel position.
    </span>
  </li>
  <li>
    <span class='signature'>
      <a href='EditorView.html#scrollToScreenPosition-instance'>
        ::<strong>scrollToScreenPosition</strong>(screenPosition, options)
      </a>
    </span>
    <span class='desc'>
      Scrolls the editor to the given screen position.
    </span>
  </li>
  <li>
    <span class='signature'>
      <a href='EditorView.html#setFontFamily-instance'>
        ::<strong>setFontFamily</strong>(fontFamily = '')
      </a>
    </span>
    <span class='desc'>
      Sets the font family for the editor.
    </span>
  </li>
  <li>
    <span class='signature'>
      <a href='EditorView.html#setFontSize-instance'>
        ::<strong>setFontSize</strong>(fontSize)
      </a>
    </span>
    <span class='desc'>
      Sets the font size for the editor.
    </span>
  </li>
  <li>
    <span class='signature'>
      <a href='EditorView.html#setInvisibles-instance'>
        ::<strong>setInvisibles</strong>(invisibles = {})
      </a>
    </span>
    <span class='desc'>
      Defines which characters are invisible.
    </span>
  </li>
  <li>
    <span class='signature'>
      <a href='EditorView.html#setPlaceholderText-instance'>
        ::<strong>setPlaceholderText</strong>(placeholderText)
      </a>
    </span>
    <span class='desc'>
      Set the text to appear in the editor when it is empty.
    </span>
  </li>
  <li>
    <span class='signature'>
      <a href='EditorView.html#setShowIndentGuide-instance'>
        ::<strong>setShowIndentGuide</strong>(showIndentGuide)
      </a>
    </span>
    <span class='desc'>
      Sets whether you want to show the indentation guides.
    </span>
  </li>
  <li>
    <span class='signature'>
      <a href='EditorView.html#setShowInvisibles-instance'>
        ::<strong>setShowInvisibles</strong>(showInvisibles)
      </a>
    </span>
    <span class='desc'>
      Set whether invisible characters are shown.
    </span>
  </li>
  <li>
    <span class='signature'>
      <a href='EditorView.html#setSoftWrap-instance'>
        ::<strong>setSoftWrap</strong>(softWrap)
      </a>
    </span>
    <span class='desc'>
      Enables/disables soft wrap on the editor.
    </span>
  </li>
  <li>
    <span class='signature'>
      <a href='EditorView.html#splitDown-instance'>
        ::<strong>splitDown</strong>()
      </a>
    </span>
    <span class='desc'>
      Split the editor view down.
    </span>
  </li>
  <li>
    <span class='signature'>
      <a href='EditorView.html#splitLeft-instance'>
        ::<strong>splitLeft</strong>()
      </a>
    </span>
    <span class='desc'>
      Split the editor view left.
    </span>
  </li>
  <li>
    <span class='signature'>
      <a href='EditorView.html#splitRight-instance'>
        ::<strong>splitRight</strong>()
      </a>
    </span>
    <span class='desc'>
      Split the editor view right.
    </span>
  </li>
  <li>
    <span class='signature'>
      <a href='EditorView.html#splitUp-instance'>
        ::<strong>splitUp</strong>()
      </a>
    </span>
    <span class='desc'>
      Split the editor view up.
    </span>
  </li>
  <li>
    <span class='signature'>
      <a href='EditorView.html#toggleSoftTabs-instance'>
        ::<strong>toggleSoftTabs</strong>()
      </a>
    </span>
    <span class='desc'>
      Toggle soft tabs on the edit session.
    </span>
  </li>
  <li>
    <span class='signature'>
      <a href='EditorView.html#toggleSoftWrap-instance'>
        ::<strong>toggleSoftWrap</strong>()
      </a>
    </span>
    <span class='desc'>
      Toggle soft wrap on the edit session.
    </span>
  </li>
</ul>
      <h2>
        <small>Inherited Method Summary</small>
      </h2>
      <h3 class='inherited'>
        Methods inherited from
        <a href='View.html'>View</a>
      </h3>
      <p class='inherited'>
                <a href='View.html#subview-class'>@subview</a>,
                <a href='View.html#text-class'>@text</a>,
                <a href='View.html#tag-class'>@tag</a>,
                <a href='View.html#raw-class'>@raw</a>,
                <a href='View.html#command-instance'>.command</a>,
        <a href='View.html#preempt-instance'>.preempt</a>
      </p>
      <h2>Instance Method Details</h2>
      <div class='methods'>
  <div class='method_details'>
    <p class='signature' id='getEditor-instance'>
      Editor ::<strong>getEditor</strong>()
      <a class='gh-link' href='https://github.com/atom/atom'>Source</a>
    </p>
    <div class='docstring'>
  <p>Get the underlying editor model for this view.</p>
</div>
<div class='tags'>
  <h3>Returns:</h3>
  <ul class='return'>
    <li>
      <span class='type'></span>
      (<tt><a href='Editor.html'>Editor</a></tt>)
      &mdash;
      <span class='desc'>Returns an <a href='Editor.html'>Editor</a>.</span>
    </li>
  </ul>
</div>
  </div>
  <div class='method_details'>
    <p class='signature' id='getFirstVisibleScreenRow-instance'>
      Number ::<strong>getFirstVisibleScreenRow</strong>()
      <a class='gh-link' href='https://github.com/atom/atom'>Source</a>
    </p>
    <div class='docstring'>
  <p>Retrieves the number of the row that is visible and currently at the top of the editor.</p>
</div>
<div class='tags'>
  <h3>Returns:</h3>
  <ul class='return'>
    <li>
      <span class='type'></span>
      (<tt>Number</tt>)
      &mdash;
      <span class='desc'>Returns a <a href='https://developer.mozilla.org/en-US/docs/JavaScript/Reference/Global_Objects/Number'>Number</a>.</span>
    </li>
  </ul>
</div>
  </div>
  <div class='method_details'>
    <p class='signature' id='getFontFamily-instance'>
      String ::<strong>getFontFamily</strong>()
      <a class='gh-link' href='https://github.com/atom/atom'>Source</a>
    </p>
    <div class='docstring'>
  <p>Gets the font family for the editor.</p>
</div>
<div class='tags'>
  <h3>Returns:</h3>
  <ul class='return'>
    <li>
      <span class='type'></span>
      (<tt>String</tt>)
      &mdash;
      <span class='desc'>Returns a <a href='https://developer.mozilla.org/en-US/docs/JavaScript/Reference/Global_Objects/String'>String</a> identifying the CSS <code>font-family</code>.</span>
    </li>
  </ul>
</div>
  </div>
  <div class='method_details'>
    <p class='signature' id='getFontSize-instance'>
      Number ::<strong>getFontSize</strong>()
      <a class='gh-link' href='https://github.com/atom/atom'>Source</a>
    </p>
    <div class='docstring'>
  <p>Retrieves the font size for the editor.</p>
</div>
<div class='tags'>
  <h3>Returns:</h3>
  <ul class='return'>
    <li>
      <span class='type'></span>
      (<tt>Number</tt>)
      &mdash;
      <span class='desc'>Returns a <a href='https://developer.mozilla.org/en-US/docs/JavaScript/Reference/Global_Objects/Number'>Number</a> indicating the font size in pixels.</span>
    </li>
  </ul>
</div>
  </div>
  <div class='method_details'>
    <p class='signature' id='getLastVisibleScreenRow-instance'>
      Number ::<strong>getLastVisibleScreenRow</strong>()
      <a class='gh-link' href='https://github.com/atom/atom'>Source</a>
    </p>
    <div class='docstring'>
  <p>Retrieves the number of the row that is visible and currently at the bottom of the editor.</p>
</div>
<div class='tags'>
  <h3>Returns:</h3>
  <ul class='return'>
    <li>
      <span class='type'></span>
      (<tt>Number</tt>)
      &mdash;
      <span class='desc'>Returns a <a href='https://developer.mozilla.org/en-US/docs/JavaScript/Reference/Global_Objects/Number'>Number</a>.</span>
    </li>
  </ul>
</div>
  </div>
  <div class='method_details'>
    <p class='signature' id='getPageRows-instance'>
      Number ::<strong>getPageRows</strong>()
      <a class='gh-link' href='https://github.com/atom/atom'>Source</a>
    </p>
    <div class='docstring'>
  <p>Gets the number of actual page rows existing in an editor.</p>
</div>
<div class='tags'>
  <h3>Returns:</h3>
  <ul class='return'>
    <li>
      <span class='type'></span>
      (<tt>Number</tt>)
      &mdash;
      <span class='desc'>Returns a <a href='https://developer.mozilla.org/en-US/docs/JavaScript/Reference/Global_Objects/Number'>Number</a>.</span>
    </li>
  </ul>
</div>
  </div>
  <div class='method_details'>
    <p class='signature' id='getPane-instance'>
      Pane ::<strong>getPane</strong>()
      <a class='gh-link' href='https://github.com/atom/atom'>Source</a>
    </p>
    <div class='docstring'>
  <p>Get this view&#39;s pane.</p>
</div>
<div class='tags'>
  <h3>Returns:</h3>
  <ul class='return'>
    <li>
      <span class='type'></span>
      (<tt><a href='Pane.html'>Pane</a></tt>)
      &mdash;
      <span class='desc'>Returns a <a href='Pane.html'>Pane</a>.</span>
    </li>
  </ul>
</div>
  </div>
  <div class='method_details'>
    <p class='signature' id='highlightFoldsContainingBufferRange-instance'>
      ::<strong>highlightFoldsContainingBufferRange</strong>(bufferRange)
      <a class='gh-link' href='https://github.com/atom/atom'>Source</a>
    </p>
    <div class='docstring'>
  <p>Highlight all the folds within the given buffer range.</p><p>&quot;Highlighting&quot; essentially just adds the <code>fold-selected</code> class to the line&#39;s
DOM element.</p>
</div>
<div class='tags'>
  <h3>Parameters:</h3>
  <ul class='param'>
    <li>
      <span class='type'>(Range)</span>
      <span class='name'>bufferRange</span>
      &mdash;
      <span class='desc'>The <a href='Range.html'>Range</a> to check.</span>
    </li>
  </ul>
</div>
  </div>
  <div class='method_details'>
    <p class='signature' id='isScreenRowVisible-instance'>
      Boolean ::<strong>isScreenRowVisible</strong>(row)
      <a class='gh-link' href='https://github.com/atom/atom'>Source</a>
    </p>
    <div class='docstring'>
  <p>Given a row number, identifies if it is currently visible.</p>
</div>
<div class='tags'>
  <h3>Parameters:</h3>
  <ul class='param'>
    <li>
      <span class='type'>(Number)</span>
      <span class='name'>row</span>
      &mdash;
      <span class='desc'>A row <a href='https://developer.mozilla.org/en-US/docs/JavaScript/Reference/Global_Objects/Number'>Number</a> to check</span>
    </li>
  </ul>
  <h3>Returns:</h3>
  <ul class='return'>
    <li>
      <span class='type'></span>
      (<tt>Boolean</tt>)
      &mdash;
      <span class='desc'>Returns a <a href='https://developer.mozilla.org/en-US/docs/JavaScript/Reference/Global_Objects/Boolean'>Boolean</a>.</span>
    </li>
  </ul>
</div>
  </div>
  <div class='method_details'>
    <p class='signature' id='pageDown-instance'>
      ::<strong>pageDown</strong>()
      <a class='gh-link' href='https://github.com/atom/atom'>Source</a>
    </p>
    <div class='docstring'>
  <p>Emulates the &quot;page down&quot; key, where the last row of a buffer scrolls to become the first.</p>
</div>
<div class='tags'>
</div>
  </div>
  <div class='method_details'>
    <p class='signature' id='pageUp-instance'>
      ::<strong>pageUp</strong>()
      <a class='gh-link' href='https://github.com/atom/atom'>Source</a>
    </p>
    <div class='docstring'>
  <p>Emulates the &quot;page up&quot; key, where the frst row of a buffer scrolls to become the last.</p>
</div>
<div class='tags'>
</div>
  </div>
  <div class='method_details'>
    <p class='signature' id='pixelPositionForBufferPosition-instance'>
      ::<strong>pixelPositionForBufferPosition</strong>(position)
      <a class='gh-link' href='https://github.com/atom/atom'>Source</a>
    </p>
    <div class='docstring'>
  <p>Converts a buffer position to a pixel position.</p>
</div>
<div class='tags'>
  <h3>Parameters:</h3>
  <ul class='param'>
    <li>
      <span class='name'>position</span>
      &mdash;
      <span class='desc'>An object that represents a buffer position. It can be either an <a href='https://developer.mozilla.org/en-US/docs/JavaScript/Reference/Global_Objects/Object'>Object</a> (<code>{row, column}</code>), <a href='https://developer.mozilla.org/en-US/docs/JavaScript/Reference/Global_Objects/Array'>Array</a> (<code>[row, column]</code>), or <a href='Point.html'>Point</a></span>
    </li>
  </ul>
  <h3>Returns:</h3>
  <ul class='return'>
    <li>
      <span class='type'></span>
      <span class='desc'>Returns an object with two values: <code>top</code> and <code>left</code>, representing the pixel positions.</span>
    </li>
  </ul>
</div>
  </div>
  <div class='method_details'>
    <p class='signature' id='pixelPositionForScreenPosition-instance'>
      ::<strong>pixelPositionForScreenPosition</strong>(position)
      <a class='gh-link' href='https://github.com/atom/atom'>Source</a>
    </p>
    <div class='docstring'>
  <p>Converts a screen position to a pixel position.</p>
</div>
<div class='tags'>
  <h3>Parameters:</h3>
  <ul class='param'>
    <li>
      <span class='name'>position</span>
      &mdash;
      <span class='desc'>An object that represents a screen position. It can be either an <a href='https://developer.mozilla.org/en-US/docs/JavaScript/Reference/Global_Objects/Object'>Object</a> (<code>{row, column}</code>), <a href='https://developer.mozilla.org/en-US/docs/JavaScript/Reference/Global_Objects/Array'>Array</a> (<code>[row, column]</code>), or <a href='Point.html'>Point</a></span>
    </li>
  </ul>
  <h3>Returns:</h3>
  <ul class='return'>
    <li>
      <span class='type'></span>
      <span class='desc'>Returns an object with two values: <code>top</code> and <code>left</code>, representing the pixel positions.</span>
    </li>
  </ul>
</div>
  </div>
  <div class='method_details'>
    <p class='signature' id='redraw-instance'>
      ::<strong>redraw</strong>()
      <a class='gh-link' href='https://github.com/atom/atom'>Source</a>
    </p>
    <div class='docstring'>
  <p>Redraw the editor</p>
</div>
<div class='tags'>
</div>
  </div>
  <div class='method_details'>
    <p class='signature' id='scrollToBottom-instance'>
      ::<strong>scrollToBottom</strong>()
      <a class='gh-link' href='https://github.com/atom/atom'>Source</a>
    </p>
    <div class='docstring'>
  <p>Scrolls the editor to the bottom.</p>
</div>
<div class='tags'>
</div>
  </div>
  <div class='method_details'>
    <p class='signature' id='scrollToBufferPosition-instance'>
      ::<strong>scrollToBufferPosition</strong>(bufferPosition, options)
      <a class='gh-link' href='https://github.com/atom/atom'>Source</a>
    </p>
    <div class='docstring'>
  <p>Scrolls the editor to the given buffer position.</p>
</div>
<div class='tags'>
  <h3>Parameters:</h3>
  <ul class='param'>
    <li>
      <span class='name'>bufferPosition</span>
      &mdash;
      <span class='desc'>An object that represents a buffer position. It can be either an <a href='https://developer.mozilla.org/en-US/docs/JavaScript/Reference/Global_Objects/Object'>Object</a> (<code>{row, column}</code>), <a href='https://developer.mozilla.org/en-US/docs/JavaScript/Reference/Global_Objects/Array'>Array</a> (<code>[row, column]</code>), or <a href='Point.html'>Point</a></span>
    </li>
    <li>
      <span class='name'>options</span>
      &mdash;
      <span class='desc'>A hash matching the options available to <a href='EditorView.html#scrollToPixelPosition-instance'>::scrollToPixelPosition</a></span>
    </li>
  </ul>
</div>
  </div>
  <div class='method_details'>
    <p class='signature' id='scrollToCursorPosition-instance'>
      ::<strong>scrollToCursorPosition</strong>()
      <a class='gh-link' href='https://github.com/atom/atom'>Source</a>
    </p>
    <div class='docstring'>
  <p>Scrolls the editor to the position of the most recently added cursor.</p><p>The editor is also centered. </p>
</div>
<div class='tags'>
</div>
  </div>
  <div class='method_details'>
    <p class='signature' id='scrollToPixelPosition-instance'>
      ::<strong>scrollToPixelPosition</strong>(pixelPosition, options)
      <a class='gh-link' href='https://github.com/atom/atom'>Source</a>
    </p>
    <div class='docstring'>
  <p>Scrolls the editor to the given pixel position.</p>
</div>
<div class='tags'>
  <h3>Parameters:</h3>
  <ul class='param'>
    <li>
      <span class='name'>pixelPosition</span>
      &mdash;
      <span class='desc'>An object that represents a pixel position. It can be either an <a href='https://developer.mozilla.org/en-US/docs/JavaScript/Reference/Global_Objects/Object'>Object</a> (<code>{row, column}</code>), <a href='https://developer.mozilla.org/en-US/docs/JavaScript/Reference/Global_Objects/Array'>Array</a> (<code>[row, column]</code>), or <a href='Point.html'>Point</a>.</span>
    </li>
    <li>
      <span class='name'>options</span>
      &mdash;
      <span class='desc'>A hash with the following keys:</span>
    </li>
    <ul class='options'>
      <li>
        <span class='name'>center</span>
        &mdash;
        <span class='desc'>if <code>true</code>, the position is scrolled such that it&#39;s in the center of the editor</span>
      </li>
    </ul>
  </ul>
</div>
  </div>
  <div class='method_details'>
    <p class='signature' id='scrollToScreenPosition-instance'>
      ::<strong>scrollToScreenPosition</strong>(screenPosition, options)
      <a class='gh-link' href='https://github.com/atom/atom'>Source</a>
    </p>
    <div class='docstring'>
  <p>Scrolls the editor to the given screen position.</p>
</div>
<div class='tags'>
  <h3>Parameters:</h3>
  <ul class='param'>
    <li>
      <span class='name'>screenPosition</span>
      &mdash;
      <span class='desc'>An object that represents a buffer position. It can be either an <a href='https://developer.mozilla.org/en-US/docs/JavaScript/Reference/Global_Objects/Object'>Object</a> (<code>{row, column}</code>), <a href='https://developer.mozilla.org/en-US/docs/JavaScript/Reference/Global_Objects/Array'>Array</a> (<code>[row, column]</code>), or <a href='Point.html'>Point</a></span>
    </li>
    <li>
      <span class='name'>options</span>
      &mdash;
      <span class='desc'>A hash matching the options available to <a href='EditorView.html#scrollToPixelPosition-instance'>::scrollToPixelPosition</a></span>
    </li>
  </ul>
</div>
  </div>
  <div class='method_details'>
    <p class='signature' id='setFontFamily-instance'>
      ::<strong>setFontFamily</strong>(fontFamily = '')
      <a class='gh-link' href='https://github.com/atom/atom'>Source</a>
    </p>
    <div class='docstring'>
  <p>Sets the font family for the editor.</p>
</div>
<div class='tags'>
  <h3>Parameters:</h3>
  <ul class='param'>
    <li>
      <span class='type'>(String)</span>
      <span class='name'>fontFamily</span>
      &mdash;
      <span class='desc'>A <a href='https://developer.mozilla.org/en-US/docs/JavaScript/Reference/Global_Objects/String'>String</a> identifying the CSS <code>font-family</code>.</span>
    </li>
  </ul>
</div>
  </div>
  <div class='method_details'>
    <p class='signature' id='setFontSize-instance'>
      ::<strong>setFontSize</strong>(fontSize)
      <a class='gh-link' href='https://github.com/atom/atom'>Source</a>
    </p>
    <div class='docstring'>
  <p>Sets the font size for the editor.</p>
</div>
<div class='tags'>
  <h3>Parameters:</h3>
  <ul class='param'>
    <li>
      <span class='type'>(Number)</span>
      <span class='name'>fontSize</span>
      &mdash;
      <span class='desc'>A <a href='https://developer.mozilla.org/en-US/docs/JavaScript/Reference/Global_Objects/Number'>Number</a> indicating the font size in pixels.</span>
    </li>
  </ul>
</div>
  </div>
  <div class='method_details'>
    <p class='signature' id='setInvisibles-instance'>
      ::<strong>setInvisibles</strong>(invisibles = {})
      <a class='gh-link' href='https://github.com/atom/atom'>Source</a>
    </p>
    <div class='docstring'>
  <p>Defines which characters are invisible.</p>
</div>
<div class='tags'>
  <h3>Parameters:</h3>
  <ul class='param'>
    <li>
      <span class='type'>(Object)</span>
      <span class='name'>invisibles</span>
      &mdash;
      <span class='desc'>An <a href='https://developer.mozilla.org/en-US/docs/JavaScript/Reference/Global_Objects/Object'>Object</a> defining the invisible characters:</span>
    </li>
    <ul class='options'>
      <li>
        <span class='type'>(String)</span>
        <span class='name'>eol</span>
        &mdash;
        <span class='desc'>The end of line invisible <a href='https://developer.mozilla.org/en-US/docs/JavaScript/Reference/Global_Objects/String'>String</a> (default: <code>\u00ac</code>).</span>
      </li>
      <li>
        <span class='type'>(String)</span>
        <span class='name'>space</span>
        &mdash;
        <span class='desc'>The space invisible <a href='https://developer.mozilla.org/en-US/docs/JavaScript/Reference/Global_Objects/String'>String</a> (default: <code>\u00b7</code>).</span>
      </li>
      <li>
        <span class='type'>(String)</span>
        <span class='name'>tab</span>
        &mdash;
        <span class='desc'>The tab invisible <a href='https://developer.mozilla.org/en-US/docs/JavaScript/Reference/Global_Objects/String'>String</a> (default: <code>\u00bb</code>).</span>
      </li>
      <li>
        <span class='type'>(String)</span>
        <span class='name'>cr</span>
        &mdash;
        <span class='desc'>The carriage return invisible <a href='https://developer.mozilla.org/en-US/docs/JavaScript/Reference/Global_Objects/String'>String</a> (default: <code>\u00a4</code>).</span>
      </li>
    </ul>
  </ul>
</div>
  </div>
  <div class='method_details'>
    <p class='signature' id='setPlaceholderText-instance'>
      ::<strong>setPlaceholderText</strong>(placeholderText)
      <a class='gh-link' href='https://github.com/atom/atom'>Source</a>
    </p>
    <div class='docstring'>
  <p>Set the text to appear in the editor when it is empty.</p><p>This only affects mini editors.</p>
</div>
<div class='tags'>
  <h3>Parameters:</h3>
  <ul class='param'>
    <li>
      <span class='type'>(String)</span>
      <span class='name'>placeholderText</span>
      &mdash;
      <span class='desc'>A <a href='https://developer.mozilla.org/en-US/docs/JavaScript/Reference/Global_Objects/String'>String</a> of text to display when empty.</span>
    </li>
  </ul>
</div>
  </div>
  <div class='method_details'>
    <p class='signature' id='setShowIndentGuide-instance'>
      ::<strong>setShowIndentGuide</strong>(showIndentGuide)
      <a class='gh-link' href='https://github.com/atom/atom'>Source</a>
    </p>
    <div class='docstring'>
  <p>Sets whether you want to show the indentation guides.</p>
</div>
<div class='tags'>
  <h3>Parameters:</h3>
  <ul class='param'>
    <li>
      <span class='type'>(Boolean)</span>
      <span class='name'>showIndentGuide</span>
      &mdash;
      <span class='desc'>A <a href='https://developer.mozilla.org/en-US/docs/JavaScript/Reference/Global_Objects/Boolean'>Boolean</a> you can set to <code>true</code> if you want to see the indentation guides.</span>
    </li>
  </ul>
</div>
  </div>
  <div class='method_details'>
    <p class='signature' id='setShowInvisibles-instance'>
      ::<strong>setShowInvisibles</strong>(showInvisibles)
      <a class='gh-link' href='https://github.com/atom/atom'>Source</a>
    </p>
    <div class='docstring'>
  <p>Set whether invisible characters are shown.</p>
</div>
<div class='tags'>
  <h3>Parameters:</h3>
  <ul class='param'>
    <li>
      <span class='type'>(Boolean)</span>
      <span class='name'>showInvisibles</span>
      &mdash;
      <span class='desc'>A <a href='https://developer.mozilla.org/en-US/docs/JavaScript/Reference/Global_Objects/Boolean'>Boolean</a> which, if <code>true</code>, show invisible characters.</span>
    </li>
  </ul>
</div>
  </div>
  <div class='method_details'>
    <p class='signature' id='setSoftWrap-instance'>
      ::<strong>setSoftWrap</strong>(softWrap)
      <a class='gh-link' href='https://github.com/atom/atom'>Source</a>
    </p>
    <div class='docstring'>
  <p>Enables/disables soft wrap on the editor.</p>
</div>
<div class='tags'>
  <h3>Parameters:</h3>
  <ul class='param'>
    <li>
      <span class='type'>(Boolean)</span>
      <span class='name'>softWrap</span>
      &mdash;
      <span class='desc'>A <a href='https://developer.mozilla.org/en-US/docs/JavaScript/Reference/Global_Objects/Boolean'>Boolean</a> which, if <code>true</code>, enables soft wrap</span>
    </li>
  </ul>
</div>
  </div>
  <div class='method_details'>
    <p class='signature' id='splitDown-instance'>
      ::<strong>splitDown</strong>()
      <a class='gh-link' href='https://github.com/atom/atom'>Source</a>
    </p>
    <div class='docstring'>
  <p>Split the editor view down.</p>
</div>
<div class='tags'>
</div>
  </div>
  <div class='method_details'>
    <p class='signature' id='splitLeft-instance'>
      ::<strong>splitLeft</strong>()
      <a class='gh-link' href='https://github.com/atom/atom'>Source</a>
    </p>
    <div class='docstring'>
  <p>Split the editor view left.</p>
</div>
<div class='tags'>
</div>
  </div>
  <div class='method_details'>
    <p class='signature' id='splitRight-instance'>
      ::<strong>splitRight</strong>()
      <a class='gh-link' href='https://github.com/atom/atom'>Source</a>
    </p>
    <div class='docstring'>
  <p>Split the editor view right.</p>
</div>
<div class='tags'>
</div>
  </div>
  <div class='method_details'>
    <p class='signature' id='splitUp-instance'>
      ::<strong>splitUp</strong>()
      <a class='gh-link' href='https://github.com/atom/atom'>Source</a>
    </p>
    <div class='docstring'>
  <p>Split the editor view up.</p>
</div>
<div class='tags'>
</div>
  </div>
  <div class='method_details'>
    <p class='signature' id='toggleSoftTabs-instance'>
      ::<strong>toggleSoftTabs</strong>()
      <a class='gh-link' href='https://github.com/atom/atom'>Source</a>
    </p>
    <div class='docstring'>
  <p>Toggle soft tabs on the edit session.</p>
</div>
<div class='tags'>
</div>
  </div>
  <div class='method_details'>
    <p class='signature' id='toggleSoftWrap-instance'>
      ::<strong>toggleSoftWrap</strong>()
      <a class='gh-link' href='https://github.com/atom/atom'>Source</a>
    </p>
    <div class='docstring'>
  <p>Toggle soft wrap on the edit session.</p>
</div>
<div class='tags'>
</div>
  </div>
</div>
    </div>
    <div id='footer'>
  Generated on
  Wed Mar 05 2014 08:55:13 GMT-0700 (MST)
  by
  <a href='https://github.com/gjtorikian/biscotto' title='TomDoc-CoffeeScript API documentation generator'>Biscotto</a>
  v2.1.1
  (Node.js v0.10.22).
  &#10034;
  Press Ctrl-h to see the keyboard shortcuts
</div>
  </body>
</html>